<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="contentwarehouse_v1.html">Document AI Warehouse API</a> . <a href="contentwarehouse_v1.projects.html">projects</a> . <a href="contentwarehouse_v1.projects.locations.html">locations</a> . <a href="contentwarehouse_v1.projects.locations.documents.html">documents</a> . <a href="contentwarehouse_v1.projects.locations.documents.documentLinks.html">documentLinks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a link between a source document and a target document.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Remove the link between the source and target documents.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Create a link between a source document and a target document.

Args:
  parent: string, Required. Parent of the document-link to be created. parent of document-link should be a document. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DocumentLinkService.CreateDocumentLink.
  &quot;documentLink&quot;: { # A document-link between source and target document. # Required. Document links associated with the source documents (source_document_id).
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the documentLink is created.
    &quot;description&quot;: &quot;A String&quot;, # Description of this document-link.
    &quot;name&quot;: &quot;A String&quot;, # Name of this document-link. It is required that the parent derived form the name to be consistent with the source document reference. Otherwise an exception will be thrown. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}.
    &quot;sourceDocumentReference&quot;: { # References to the documents. # Document references of the source document.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the document is created.
      &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. The time when the document is deleted.
      &quot;displayName&quot;: &quot;A String&quot;, # display_name of the referenced document; this name does not need to be consistent to the display_name in the Document proto, depending on the ACL constraint.
      &quot;documentIsFolder&quot;: True or False, # The document type of the document being referenced.
      &quot;documentIsLegalHoldFolder&quot;: True or False, # Document is a folder with legal hold.
      &quot;documentIsRetentionFolder&quot;: True or False, # Document is a folder with retention policy.
      &quot;documentName&quot;: &quot;A String&quot;, # Required. Name of the referenced document.
      &quot;snippet&quot;: &quot;A String&quot;, # Stores the subset of the referenced document&#x27;s content. This is useful to allow user peek the information of the referenced document.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the document is last updated.
    },
    &quot;state&quot;: &quot;A String&quot;, # The state of the documentlink. If target node has been deleted, the link is marked as invalid. Removing a source node will result in removal of all associated links.
    &quot;targetDocumentReference&quot;: { # References to the documents. # Document references of the target document.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the document is created.
      &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. The time when the document is deleted.
      &quot;displayName&quot;: &quot;A String&quot;, # display_name of the referenced document; this name does not need to be consistent to the display_name in the Document proto, depending on the ACL constraint.
      &quot;documentIsFolder&quot;: True or False, # The document type of the document being referenced.
      &quot;documentIsLegalHoldFolder&quot;: True or False, # Document is a folder with legal hold.
      &quot;documentIsRetentionFolder&quot;: True or False, # Document is a folder with retention policy.
      &quot;documentName&quot;: &quot;A String&quot;, # Required. Name of the referenced document.
      &quot;snippet&quot;: &quot;A String&quot;, # Stores the subset of the referenced document&#x27;s content. This is useful to allow user peek the information of the referenced document.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the document is last updated.
    },
    &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the documentLink is last updated.
  },
  &quot;requestMetadata&quot;: { # Meta information is used to improve the performance of the service. # The meta information collected about the document creator, used to enforce access control for the service.
    &quot;userInfo&quot;: { # The user information. # Provides user unique identification and groups information.
      &quot;groupIds&quot;: [ # The unique group identifications which the user is belong to. The format is &quot;group:yyyy@example.com&quot;;
        &quot;A String&quot;,
      ],
      &quot;id&quot;: &quot;A String&quot;, # A unique user identification string, as determined by the client. The maximum number of allowed characters is 255. Allowed characters include numbers 0 to 9, uppercase and lowercase letters, and restricted special symbols (:, @, +, -, _, ~) The format is &quot;user:xxxx@example.com&quot;;
    },
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A document-link between source and target document.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the documentLink is created.
  &quot;description&quot;: &quot;A String&quot;, # Description of this document-link.
  &quot;name&quot;: &quot;A String&quot;, # Name of this document-link. It is required that the parent derived form the name to be consistent with the source document reference. Otherwise an exception will be thrown. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}.
  &quot;sourceDocumentReference&quot;: { # References to the documents. # Document references of the source document.
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the document is created.
    &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. The time when the document is deleted.
    &quot;displayName&quot;: &quot;A String&quot;, # display_name of the referenced document; this name does not need to be consistent to the display_name in the Document proto, depending on the ACL constraint.
    &quot;documentIsFolder&quot;: True or False, # The document type of the document being referenced.
    &quot;documentIsLegalHoldFolder&quot;: True or False, # Document is a folder with legal hold.
    &quot;documentIsRetentionFolder&quot;: True or False, # Document is a folder with retention policy.
    &quot;documentName&quot;: &quot;A String&quot;, # Required. Name of the referenced document.
    &quot;snippet&quot;: &quot;A String&quot;, # Stores the subset of the referenced document&#x27;s content. This is useful to allow user peek the information of the referenced document.
    &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the document is last updated.
  },
  &quot;state&quot;: &quot;A String&quot;, # The state of the documentlink. If target node has been deleted, the link is marked as invalid. Removing a source node will result in removal of all associated links.
  &quot;targetDocumentReference&quot;: { # References to the documents. # Document references of the target document.
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the document is created.
    &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. The time when the document is deleted.
    &quot;displayName&quot;: &quot;A String&quot;, # display_name of the referenced document; this name does not need to be consistent to the display_name in the Document proto, depending on the ACL constraint.
    &quot;documentIsFolder&quot;: True or False, # The document type of the document being referenced.
    &quot;documentIsLegalHoldFolder&quot;: True or False, # Document is a folder with legal hold.
    &quot;documentIsRetentionFolder&quot;: True or False, # Document is a folder with retention policy.
    &quot;documentName&quot;: &quot;A String&quot;, # Required. Name of the referenced document.
    &quot;snippet&quot;: &quot;A String&quot;, # Stores the subset of the referenced document&#x27;s content. This is useful to allow user peek the information of the referenced document.
    &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the document is last updated.
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the documentLink is last updated.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, body=None, x__xgafv=None)</code>
  <pre>Remove the link between the source and target documents.

Args:
  name: string, Required. The name of the document-link to be deleted. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DocumentLinkService.DeleteDocumentLink.
  &quot;requestMetadata&quot;: { # Meta information is used to improve the performance of the service. # The meta information collected about the document creator, used to enforce access control for the service.
    &quot;userInfo&quot;: { # The user information. # Provides user unique identification and groups information.
      &quot;groupIds&quot;: [ # The unique group identifications which the user is belong to. The format is &quot;group:yyyy@example.com&quot;;
        &quot;A String&quot;,
      ],
      &quot;id&quot;: &quot;A String&quot;, # A unique user identification string, as determined by the client. The maximum number of allowed characters is 255. Allowed characters include numbers 0 to 9, uppercase and lowercase letters, and restricted special symbols (:, @, +, -, _, ~) The format is &quot;user:xxxx@example.com&quot;;
    },
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

</body></html>